SureTax Returns API

DELETE Form Instances

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint enables the deletion of generated form instances from the system. It provides clients with the ability to remove specific form instances that are no longer needed or relevant, helping to maintain data integrity and system cleanliness.

OperationId: DELETE Form Instances

Authorization Method(s): OAuth

Verb: DELETE

End Point: /api/v1/Forms/FormInstances

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

DeleteFormInstancesResponse

OVERVIEWEXAMPLE

Overview

DeleteFormInstancesResponse

Display Name	Field Name	Field Type
Data	data	DeleteFormInstancesData

DeleteFormInstancesData

Display Name	Field Name	Field Type
Form Instances	formInstances	array[FormDeleteInstanceError]

FormDeleteInstanceError

Display Name	Field Name	Field Type
Id	id	string
Error Message	errorMessage	string

Example Response

{
  "data": {
    "formInstances": [
      {
        "id": "FORM12345",
        "errorMessage": "No errors."
      },
      {
        "id": "FORM67890",
        "errorMessage": "Error while deleting form instance."
      }
    ]
  }
}

Response Codes

code	description
200	The API response contains the status of the deleted form instances along with any error messages.
400	Bad request. Invalid data provided.
401	Unauthorized access.
500	Internal server error.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstances

Add Request Headers: